Alias

SignerProcessDocumentsReading

Description

Obtains information on the documents signed in a signature process. In particular, it obtains information on the result obtained when each signature was made.

Request

GET /trustedx-resources/esignsp/v2/signer_processes/{signature_process_id}/documents

Parameters

Name	Type	Usage	Description
`signature_process_id`	path	Required	Identifier of the document signature process used to sign the documents.

Authorization

The request must contain a bearer access token generated by an authorization server of the platform. This token must have a scope that includes the urn:safelayer:eidas:sign:process:document value and must be used as explained in RFC 6750. Basically, the access token must be included in an Authorization header as follows:

Authorization: Bearer <token>

The access token can be obtained via an authorization code grant or client credentials grant OAuth 2.0 flow.

Response

Status-Line

Value	Description
`HTTP/1.1 200 OK`	The information requested is provided in the body of the response (`Content-Type: application/json`).
Others	See HTTP Response Status for all the possible cases.

Content-Type Header

Content-Type: application/json

Body

If the operation is performed successfully, the body contains a JSON object with the following structure:

Content-Type: application/json
 
{
    "documents" : [{
        "id" : {string},
        "url" : {string},
        "content: {string},
        "result" : {
            "status" : {string},
            "details" : {
                 "message" : {string}
            }
        }
    }]
}

Property	Description
`documents[]`	Information on the documents signed in the process.
`documents[].id`	Identifier of one of the documents.
`documents[].url`	URL of the document and signature definitions resource for one of the documents.
`documents[].content`	URL of one of the documents.
`documents[].result`	Result of the signing of one of the documents: `"finished"`: The document was signed correctly. `"failed"`: The document was not signed because an error occurred. `"canceled"`: The document was not signed because the signature process was canceled.
`documents[].details.message`	Message describing the error in the signing of one of the documents. This property is only present when the result of the document signing is `failed`.